Skip to content

docs(README): add "pre-commit install --hook-type commit-msg" command #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 13, 2020

Conversation

Lee-W
Copy link
Member

@Lee-W Lee-W commented Jul 4, 2020

… to pre-commit section

(Thanks for sending a pull request! Please fill in the following content to let us know better about this change.)

Types of changes

Please put an x in the box that applies

  • Documentation Update
  • CI Update

Description

docs(README): add "pre-commit install --hook-type commit-msg" command
ci: rename scripts/reformat as scripts/format

Checklist:

  • Add test cases to all the changes you introduce
  • Run ./script/reformat and ./script/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Steps to Test This Pull Request

None

Expected behavior

None

Related Issue

If applicable, reference to the issue related to this pull request.

Additional context

Add any other context or screenshots about the pull request here.

@woile
Copy link
Member

woile commented Jul 4, 2020

Should we add pre-commit as dev-dependecy?

@codecov
Copy link

codecov bot commented Jul 4, 2020

Codecov Report

Merging #218 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #218   +/-   ##
=======================================
  Coverage   95.64%   95.64%           
=======================================
  Files          34       34           
  Lines         942      942           
=======================================
  Hits          901      901           
  Misses         41       41           
Flag Coverage Δ
#unittests 95.64% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 085294b...a37ed5c. Read the comment docs.

@alecgerona
Copy link
Contributor

Having dev dependencies on poetry really makes me wanna ditch pip.

@Lee-W
Copy link
Member Author

Lee-W commented Jul 6, 2020

It seems we'll need to change the lowest python version from 3.6 to 3.6.1 to add pre-commit as dev deps. If that's ok, I can add it.

@Lee-W Lee-W requested a review from woile July 12, 2020 09:19
@Lee-W Lee-W force-pushed the fix-pre-commit-config-doc branch from 25fee0a to cfac0b3 Compare July 12, 2020 09:26
@Lee-W Lee-W removed the request for review from woile July 12, 2020 09:30
@Lee-W Lee-W marked this pull request as draft July 12, 2020 09:30
@Lee-W Lee-W marked this pull request as ready for review July 13, 2020 06:44
@woile
Copy link
Member

woile commented Jul 13, 2020

Nice!

@Lee-W Lee-W force-pushed the fix-pre-commit-config-doc branch from 28bcd1c to 2133992 Compare July 13, 2020 09:19
@Lee-W Lee-W merged commit 3f91066 into master Jul 13, 2020
@Lee-W Lee-W deleted the fix-pre-commit-config-doc branch July 13, 2020 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants